home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / zgbsvx.z / zgbsvx
Text File  |  1996-03-14  |  14KB  |  331 lines
  1.  
  2.  
  3.  
  4. ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZGBSVX - use the LU factorization to compute the solution to a complex
  10.      system of linear equations A * X = B, A**T * X = B, or A**H * X = B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZGBSVX( FACT, TRANS, N, KL, KU, NRHS, AB, LDAB, AFB, LDAFB,
  14.                         IPIV, EQUED, R, C, B, LDB, X, LDX, RCOND, FERR, BERR,
  15.                         WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      EQUED, FACT, TRANS
  18.  
  19.          INTEGER        INFO, KL, KU, LDAB, LDAFB, LDB, LDX, N, NRHS
  20.  
  21.          DOUBLE         PRECISION RCOND
  22.  
  23.          INTEGER        IPIV( * )
  24.  
  25.          DOUBLE         PRECISION BERR( * ), C( * ), FERR( * ), R( * ), RWORK(
  26.                         * )
  27.  
  28.          COMPLEX*16     AB( LDAB, * ), AFB( LDAFB, * ), B( LDB, * ), WORK( *
  29.                         ), X( LDX, * )
  30.  
  31. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  32.      ZGBSVX uses the LU factorization to compute the solution to a complex
  33.      system of linear equations A * X = B, A**T * X = B, or A**H * X = B,
  34.      where A is a band matrix of order N with KL subdiagonals and KU
  35.      superdiagonals, and X and B are N-by-NRHS matrices.
  36.  
  37.      Error bounds on the solution and a condition estimate are also provided.
  38.  
  39.  
  40. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  41.      The following steps are performed by this subroutine:
  42.  
  43.      1. If FACT = 'E', real scaling factors are computed to equilibrate
  44.         the system:
  45.            TRANS = 'N':  diag(R)*A*diag(C)     *inv(diag(C))*X = diag(R)*B
  46.            TRANS = 'T': (diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
  47.            TRANS = 'C': (diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
  48.         Whether or not the system will be equilibrated depends on the
  49.         scaling of the matrix A, but if equilibration is used, A is
  50.         overwritten by diag(R)*A*diag(C) and B by diag(R)*B (if TRANS='N')
  51.         or diag(C)*B (if TRANS = 'T' or 'C').
  52.  
  53.      2. If FACT = 'N' or 'E', the LU decomposition is used to factor the
  54.         matrix A (after equilibration if FACT = 'E') as
  55.            A = L * U,
  56.         where L is a product of permutation and unit lower triangular
  57.         matrices with KL subdiagonals, and U is upper triangular with
  58.         KL+KU superdiagonals.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      3. The factored form of A is used to estimate the condition number
  75.         of the matrix A.  If the reciprocal of the condition number is
  76.         less than machine precision, steps 4-6 are skipped.
  77.  
  78.      4. The system of equations is solved for X using the factored form
  79.         of A.
  80.  
  81.      5. Iterative refinement is applied to improve the computed solution
  82.         matrix and calculate error bounds and backward error estimates
  83.         for it.
  84.  
  85.      6. If equilibration was used, the matrix X is premultiplied by
  86.         diag(C) (if TRANS = 'N') or diag(R) (if TRANS = 'T' or 'C') so
  87.         that it solves the original system before equilibration.
  88.  
  89.  
  90. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  91.      FACT    (input) CHARACTER*1
  92.              Specifies whether or not the factored form of the matrix A is
  93.              supplied on entry, and if not, whether the matrix A should be
  94.              equilibrated before it is factored.  = 'F':  On entry, AFB and
  95.              IPIV contain the factored form of A.  If EQUED is not 'N', the
  96.              matrix A has been equilibrated with scaling factors given by R
  97.              and C.  AB, AFB, and IPIV are not modified.  = 'N':  The matrix A
  98.              will be copied to AFB and factored.
  99.              = 'E':  The matrix A will be equilibrated if necessary, then
  100.              copied to AFB and factored.
  101.  
  102.      TRANS   (input) CHARACTER*1
  103.              Specifies the form of the system of equations.  = 'N':  A * X = B
  104.              (No transpose)
  105.              = 'T':  A**T * X = B  (Transpose)
  106.              = 'C':  A**H * X = B  (Conjugate transpose)
  107.  
  108.      N       (input) INTEGER
  109.              The number of linear equations, i.e., the order of the matrix A.
  110.              N >= 0.
  111.  
  112.      KL      (input) INTEGER
  113.              The number of subdiagonals within the band of A.  KL >= 0.
  114.  
  115.      KU      (input) INTEGER
  116.              The number of superdiagonals within the band of A.  KU >= 0.
  117.  
  118.      NRHS    (input) INTEGER
  119.              The number of right hand sides, i.e., the number of columns of
  120.              the matrices B and X.  NRHS >= 0.
  121.  
  122.      AB      (input/output) COMPLEX*16 array, dimension (LDAB,N)
  123.              On entry, the matrix A in band storage, in rows 1 to KL+KU+1.
  124.              The j-th column of A is stored in the j-th column of the array AB
  125.              as follows:  AB(KU+1+i-j,j) = A(i,j) for max(1,j-
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              KU)<=i<=min(N,j+kl)
  141.  
  142.              If FACT = 'F' and EQUED is not 'N', then A must have been
  143.              equilibrated by the scaling factors in R and/or C.  AB is not
  144.              modified if FACT = 'F' or 'N', or if FACT = 'E' and EQUED = 'N'
  145.              on exit.
  146.  
  147.              On exit, if EQUED .ne. 'N', A is scaled as follows:  EQUED = 'R':
  148.              A := diag(R) * A
  149.              EQUED = 'C':  A := A * diag(C)
  150.              EQUED = 'B':  A := diag(R) * A * diag(C).
  151.  
  152.      LDAB    (input) INTEGER
  153.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  154.  
  155.      AFB     (input or output) COMPLEX*16 array, dimension (LDAFB,N)
  156.              If FACT = 'F', then AFB is an input argument and on entry
  157.              contains details of the LU factorization of the band matrix A, as
  158.              computed by ZGBTRF.  U is stored as an upper triangular band
  159.              matrix with KL+KU superdiagonals in rows 1 to KL+KU+1, and the
  160.              multipliers used during the factorization are stored in rows
  161.              KL+KU+2 to 2*KL+KU+1.  If EQUED .ne. 'N', then AFB is the
  162.              factored form of the equilibrated matrix A.
  163.  
  164.              If FACT = 'N', then AFB is an output argument and on exit returns
  165.              details of the LU factorization of A.
  166.  
  167.              If FACT = 'E', then AFB is an output argument and on exit returns
  168.              details of the LU factorization of the equilibrated matrix A (see
  169.              the description of AB for the form of the equilibrated matrix).
  170.  
  171.      LDAFB   (input) INTEGER
  172.              The leading dimension of the array AFB.  LDAFB >= 2*KL+KU+1.
  173.  
  174.      IPIV    (input or output) INTEGER array, dimension (N)
  175.              If FACT = 'F', then IPIV is an input argument and on entry
  176.              contains the pivot indices from the factorization A = L*U as
  177.              computed by ZGBTRF; row i of the matrix was interchanged with row
  178.              IPIV(i).
  179.  
  180.              If FACT = 'N', then IPIV is an output argument and on exit
  181.              contains the pivot indices from the factorization A = L*U of the
  182.              original matrix A.
  183.  
  184.              If FACT = 'E', then IPIV is an output argument and on exit
  185.              contains the pivot indices from the factorization A = L*U of the
  186.              equilibrated matrix A.
  187.  
  188.      EQUED   (input or output) CHARACTER*1
  189.              Specifies the form of equilibration that was done.  = 'N':  No
  190.              equilibration (always true if FACT = 'N').
  191.              = 'R':  Row equilibration, i.e., A has been premultiplied by
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206.              diag(R).  = 'C':  Column equilibration, i.e., A has been
  207.              postmultiplied by diag(C).  = 'B':  Both row and column
  208.              equilibration, i.e., A has been replaced by diag(R) * A *
  209.              diag(C).  EQUED is an input argument if FACT = 'F'; otherwise, it
  210.              is an output argument.
  211.  
  212.      R       (input or output) DOUBLE PRECISION array, dimension (N)
  213.              The row scale factors for A.  If EQUED = 'R' or 'B', A is
  214.              multiplied on the left by diag(R); if EQUED = 'N' or 'C', R is
  215.              not accessed.  R is an input argument if FACT = 'F'; otherwise, R
  216.              is an output argument.  If FACT = 'F' and EQUED = 'R' or 'B',
  217.              each element of R must be positive.
  218.  
  219.      C       (input or output) DOUBLE PRECISION array, dimension (N)
  220.              The column scale factors for A.  If EQUED = 'C' or 'B', A is
  221.              multiplied on the right by diag(C); if EQUED = 'N' or 'R', C is
  222.              not accessed.  C is an input argument if FACT = 'F'; otherwise, C
  223.              is an output argument.  If FACT = 'F' and EQUED = 'C' or 'B',
  224.              each element of C must be positive.
  225.  
  226.      B       (input/output) COMPLEX*16 array, dimension (LDB,NRHS)
  227.              On entry, the right hand side matrix B.  On exit, if EQUED = 'N',
  228.              B is not modified; if TRANS = 'N' and EQUED = 'R' or 'B', B is
  229.              overwritten by diag(R)*B; if TRANS = 'T' or 'C' and EQUED = 'C'
  230.              or 'B', B is overwritten by diag(C)*B.
  231.  
  232.      LDB     (input) INTEGER
  233.              The leading dimension of the array B.  LDB >= max(1,N).
  234.  
  235.      X       (output) COMPLEX*16 array, dimension (LDX,NRHS)
  236.              If INFO = 0, the n-by-nrhs solution matrix X to the original
  237.              system of equations.  Note that A and B are modified on exit if
  238.              EQUED .ne. 'N', and the solution to the equilibrated system is
  239.              inv(diag(C))*X if TRANS = 'N' and EQUED = 'C' or or 'B'.
  240.  
  241.      LDX     (input) INTEGER
  242.              The leading dimension of the array X.  LDX >= max(1,N).
  243.  
  244.      RCOND   (output) DOUBLE PRECISION
  245.              The estimate of the reciprocal condition number of the matrix A
  246.              after equilibration (if done).  If RCOND is less than the machine
  247.              precision (in particular, if RCOND = 0), the matrix is singular
  248.              to working precision.  This condition is indicated by a return
  249.              code of INFO > 0, and the solution and error bounds are not
  250.              computed.
  251.  
  252.      FERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  253.              The estimated forward error bound for each solution vector X(j)
  254.              (the j-th column of the solution matrix X).  If XTRUE is the true
  255.              solution corresponding to X(j), FERR(j) is an estimated upper
  256.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  257.              divided by the magnitude of the largest element in X(j).  The
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          ZZZZGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  269.  
  270.  
  271.  
  272.              estimate is as reliable as the estimate for RCOND, and is almost
  273.              always a slight overestimate of the true error.
  274.  
  275.      BERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  276.              The componentwise relative backward error of each solution vector
  277.              X(j) (i.e., the smallest relative change in any element of A or B
  278.              that makes X(j) an exact solution).
  279.  
  280.      WORK    (workspace) COMPLEX*16 array, dimension (2*N)
  281.  
  282.      RWORK   (workspace/output) DOUBLE PRECISION array, dimension (N)
  283.              On exit, RWORK(1) contains the reciprocal pivot growth factor
  284.              norm(A)/norm(U). The "max absolute element" norm is used. If
  285.              RWORK(1) is much less than 1, then the stability of the LU
  286.              factorization of the (equilibrated) matrix A could be poor. This
  287.              also means that the solution X, condition estimator RCOND, and
  288.              forward error bound FERR could be unreliable. If factorization
  289.              fails with 0<INFO<=N, then RWORK(1) contains the reciprocal pivot
  290.              growth factor for the leading INFO columns of A.
  291.  
  292.      INFO    (output) INTEGER
  293.              = 0:  successful exit
  294.              < 0:  if INFO = -i, the i-th argument had an illegal value
  295.              > 0:  if INFO = i, and i is
  296.              <= N:  U(i,i) is exactly zero.  The factorization has been
  297.              completed, but the factor U is exactly singular, so the solution
  298.              and error bounds could not be computed.  = N+1: RCOND is less
  299.              than machine precision.  The factorization has been completed,
  300.              but the matrix A is singular to working precision, and the
  301.              solution and error bounds have not been computed.
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.